vcProgramManager

Container for programs.

See in: Overview

Module: vcExecutor2

Parent: -

Children: vcRobotProgramManager

Referenced by: vcProgram.ProgramManager

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
ProgramsvcList[vcProgram]RGets a list of contained programs

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
clearProgramsNoneNoneDeletes all programs from the manager.

Parameters:
None

Returns:
None
copyProgramvcProgramvcProgram program,
Optional Keyword[index = Integer]
Copies an existing program into this manager.
See more
Parameters:
program (vcProgram): The program to copy.
Optional: index (int): Index to insert the new program at.

Returns:
vcProgram: The new program.

Exceptions:
RuntimeError: When copying fails.
createProgramvcProgramOptional Keyword[name = String]Creates a new program.
See more
Parameters:
Optional: name (str): Name for the new program.

Returns:
vcProgram: The new program.

Exceptions:
ValueError: When the program name is reserved.
findProgramvcProgramString nameFinds a program with the given name.
See more
Parameters:
name (str): Name of a contained program.

Returns:
vcProgram | None: Found program or None.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnProgramAddedvcProgramManager manager,
vcProgram program
Triggered when a program is added to the manager.
See more
Parameters:
manager (vcExecutor2.vcProgramManager): The manager.
program (vcExecutor2.vcProgram): Added program instance.
OnProgramRemovingvcProgramManager manager,
vcProgram program
Triggered when a program is about to be deleted from the manager.
See more
Parameters:
manager (vcExecutor2.vcProgramManager): The manager.
program (vcExecutor2.vcProgram): Deleted program instance.